This team exercise has you starting to create your design documentation.
/docs
directory.Designdoc.md
template file is in markdown format. Check the Resources page for tools to edit markdown files.Note: You must have the actual image files physically in your repository /docs
directory. When the PDF generator runs, it will most likely not have the necessary permissions to access a remote resource holding an image file. This is also a good practice because it will allow you to track revisions of your documentation including which images were placed in revisions of the document.
master
branch and push to the remote.A PDF (Portable Document Format) is a professional looking document which includes page numbers and figure captions. There are a few options avialable to create PDF from markdown files:
DesignDoc.md
and right-click in the file area and choose Markdown PDF: (Export pdf).DesignDoc.pdf
will be created in the /docs
directory/docs
directory, use the maven command: mvn exec:exec@docs
. The PDF file will be in DesignDoc.pdf
file.Notes
- For anybody trying to run the
mvn exec:exec@docs
and receiving errors on a mac, this may be caused by a missing dependency calledpdflatex
. It can be fixed by installingmactex
via homebrew as described here: https://superuser.com/questions/1038612/where-do-i-get-the-pdflatex-program-for-mac
- If you want to generate the PDF outside of maven, use the command:
pandoc DesignDoc.md -o DesignDoc.pdf
By the time specified on the schedule for your section, put only the generated DesignDoc.pdf
file in the Design documentation - team in the MyCourses Assignments Team Exercises area.